Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[OpenAI] Update properties back from optional to nullable #24039

Merged
merged 1 commit into from
May 18, 2023
Merged

[OpenAI] Update properties back from optional to nullable #24039

merged 1 commit into from
May 18, 2023

Conversation

deyaaeldeen
Copy link
Member

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

@deyaaeldeen deyaaeldeen requested review from lmazuel and trrwilson May 18, 2023 01:06
@deyaaeldeen deyaaeldeen requested a review from yangyuan as a code owner May 18, 2023 01:06
@openapi-workflow-bot
Copy link

Hi, @deyaaeldeen Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand] 
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️❌TypeSpecAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️❌TypeSpec Validation: 3 Errors, 9 Warnings failed [Detail]
    Rule Message
    ❌ MissingExamplesDirectory "details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference,
    please ensure the 'examples' is added in the PR."
    ❌ SwaggerNotExistInPRBranch "details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch."
    ❌ SwaggerNotExistInPRBranch "details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch."
    ⚠️ [@azure-tools/typespec-azure-core/no-nullable: Don't use ` null. If you meant to have an optional property, use ?. (e.g. myProp?](undefined)
    ⚠️ [@azure-tools/typespec-azure-core/no-nullable: Don't use ` null. If you meant to have an optional property, use ?. (e.g. myProp?](undefined)
    ⚠️ [@azure-tools/typespec-azure-core/no-nullable: Don't use ` null. If you meant to have an optional property, use ?. (e.g. myProp?](undefined)
    ⚠️ @azure-tools/typespec-autorest/union-unsupported Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.
    Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L196
    ⚠️ @azure-tools/typespec-autorest/union-unsupported Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.
    Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L161
    ⚠️ @azure-tools/typespec-autorest/union-unsupported Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.
    Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L196
    ⚠️ @azure-tools/typespec-autorest/union-unsupported Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type.
    Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L161
    ⚠️ MissingTypeSpecProjectConfig "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference,
    please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'."
    ⚠️ MissingTypeSpecProjectConfig "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference,
    please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'."
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • ❌Code Generator Failed [Logs]Release - Generate from 4abcb50. SDK Automation 14.0.0 
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mException: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:133
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 133 | �[0m             �[36;1mthrow "Not provide service name or namespace."�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mNot provide service name or namespace.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1
warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4abcb50. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
warn	No file changes detected after generation
warn	No package detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Cognitive Services label May 18, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    TypeSpec OpenAI.Inference Create ApiView failed. Please ask PR assignee for help

    @tjprescott tjprescott merged commit 4abcb50 into main May 18, 2023
    @tjprescott tjprescott deleted the openai-nullable branch May 18, 2023 21:51
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @trrwilson trrwilson trrwilson approved these changes

    @jpalvarezl jpalvarezl jpalvarezl approved these changes

    @lmazuel lmazuel Awaiting requested review from lmazuel

    @yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

    Assignees

    @tjprescott tjprescott

    Labels
    Cognitive Services
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @deyaaeldeen @jpalvarezl @trrwilson @tjprescott